home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 May / Macworld (1998-05).dmg / Shareware World / Info / Develop / AppleScript / ARAScriptingAddition / ARA Osax Read Me < prev    next >
Encoding:
Text File  |  1996-02-22  |  6.5 KB  |  201 lines  |  [TEXT/ttxt]

  1. ARA Scripting Extension
  2. © 1996 Guillaume Besse, Full Resource
  3. eMail : guyom@fra.fr
  4.  
  5. Guillaume Besse
  6. 15, rue Brown Sequard
  7. 75015 Paris
  8. France
  9.  
  10.  
  11.  
  12. What is ARA ?
  13.  
  14. ARA stands for "Apple Remote Access". ARA is a software set that enables a dialup connection
  15. to maintain the AppleTalk network protocol. With ARA, you can mount a remote server as if it
  16. was local to your machine, or access whatever service is available on the network you are connected
  17. onto. 
  18.  
  19.  
  20. What is an OSAX ?
  21.  
  22. An OSAX is an Apple Scripting Extension, an piece of software that extends the standard
  23. AppleScript vocabulary. 
  24.  
  25.  
  26. What is a ShareWare ?
  27.  
  28. This piece of software is distributed as ShareWare. This means that if you use it, you should send me
  29. FF100 or US$25. Then you will receive the latest full version, and be notified each time a new release
  30. appears. 
  31.  
  32.  
  33. What is "ARA Scripting Addition" ?
  34.  
  35. The "ARA Scripting Addition" adds new commands to open, get information about, and close ARA connections. 
  36.  
  37.  
  38. How do I install it ?
  39.  
  40. To install ARA Scripting Addition, you need a system (> 7.0) supporting AppleScript. Just drag the
  41. file "ARA Scripting Addition" to your system folder. It will be automatically put in the Extensions folder. 
  42.  
  43.  
  44. New AppleScript commands
  45.  
  46.  
  47.        ara connect file string
  48.        [asynchronous boolean]
  49.        [tarification level integer] -- not yet implemented
  50.  
  51.        Opens a connection using the file whose path is given as a direct parameter. Set the asynchronous parameter to
  52.        true to open the connection asynchronously, and to false to open it using the ARA modal progress dialog. 
  53.  
  54.        ara connect string
  55.        [username string]
  56.        [password string]
  57.        [asynchronous boolean] 
  58.        [compatibility version1/version2/version3/versionX] -- not yet implemented
  59.        [tarification level integer] -- not yet implemented
  60.  
  61.        Opens a connection using the specified username and password. If there is no username specified, the connection
  62.        is opened in guest mode. Set the asynchronous parameter to true to open the connection asynchronously, and to
  63.        false to open it using the ARA modal progress dialog. 
  64.  
  65.        ara disconnect
  66.        [asynchronous boolean] 
  67.  
  68.        Closes the current connection. Set the asynchronous parameter to true to close the connection asynchronously, and
  69.        to false to close it using the ARA modal progress dialog. 
  70.  
  71.        ara status
  72.        Result: integer
  73.  
  74.        This call returns an integer describing the state of the connection. 
  75.  
  76.        ara error number
  77.        Result: integer
  78.  
  79.        This call returns the number of the error which occured on the last call of an ARA command. 
  80.  
  81.        ara error string
  82.        Result: string
  83.  
  84.        This call returns the textual description of the error which occured on the last call of an ARA command. 
  85.  
  86.        ara user name
  87.        Result: string
  88.  
  89.        This call returns the username with which the current connection was opened. 
  90.  
  91.        ara server name
  92.        Result: string
  93.  
  94.        This call returns the name of the ARA server to which you are currently connected. 
  95.  
  96.        ara message
  97.        Result: string
  98.  
  99.        This call returns the message describing the current connection status, like "Connected at 14400 bauds". 
  100.  
  101.        ara is answering
  102.        Result: boolean
  103.  
  104.        True if we are currently answering an incoming call. 
  105.  
  106.        ara is calling
  107.        Result: boolean
  108.  
  109.        True if we are currently calling a remote ARA server. 
  110.  
  111.        ara is aborting
  112.        Result: boolean
  113.  
  114.        True if we are aborting a connection attempt, a running connection, or an incoming call process. 
  115.  
  116.        ara is connected
  117.        Result: boolean
  118.  
  119.        True if we are currently connected to a remote computer via ARA. 
  120.  
  121.        ara is disconnecting
  122.        Result: boolean
  123.  
  124.        True if we are currently disconnecting from a remote computer. 
  125.  
  126.        ara is guest
  127.        Result: boolean
  128.  
  129.        True if the current outgoing connection is made in guest mode. 
  130.  
  131.        ara connection is v2
  132.        Result: boolean
  133.  
  134.        True if thje current connection is using the version 2 of the ARA protocol. 
  135.  
  136.        ara is notifying
  137.        Result: boolean
  138.  
  139.        True if we are notifying the user that a current connection is running. 
  140.  
  141.        ara connection is multinode
  142.        Result: boolean
  143.  
  144.        True if the ARA connection allows access to other computers on the server's network. 
  145.  
  146.        ara connection time
  147.        Result: integer
  148.  
  149.        Returns the numbers of seconds since the connection started. Negative if there is no connection running. 
  150.  
  151.        ara time left
  152.        Result: integer
  153.  
  154.        Returns the number of seconds remaining before the remote server closes the connection. Negative if there is no
  155.        connection running. 
  156.  
  157.        ara is client only
  158.        Result: boolean
  159.  
  160.        True if the ARA software currently installed on this machine is for client only. False if this is a server. 
  161.  
  162.        ara is multiport server
  163.        Result: boolean
  164.  
  165.        True if the ARA software currently installed on this machine is a multiport server, accepting several connections at
  166.        the same time. 
  167.  
  168.        ara is version 2
  169.        Result: boolean
  170.  
  171.        True if the ARA software currently installed on this machine is version 2. 
  172.  
  173.        ara is version 3 -- not yet implemented
  174.        Result: boolean
  175.  
  176.        ara osax version
  177.        Result: string
  178.  
  179.        Returns the version of this OSAX. 
  180.  
  181.        ara osax help
  182.        Result: string
  183.  
  184.        Returns the help text about this OSAX. 
  185.  
  186.        ara shareware info
  187.        Result: string
  188.  
  189.        Returns shareware information about this OSAX: registering, etc. 
  190.  
  191.  
  192. Distribution
  193.  
  194. This software is not in the public domain; rather it is Copyright ©1996 by Guillaume Besse. You may freely copy and distribute this software, provided that it you do not charge for it.  This software may be included in any disk or CD-ROM library of public domain and shareware software sold by a NON-PROFIT organization. This software may not be included in any commercial software collection sold for profit, nor may it be bundled with any commercial software, hardware, books, or other media without the prior written consent of the author. Whenever it is distributed, the "ARA Scripting Addition" must be accompanied with its documentation files.  
  195.  
  196. Disclaimer
  197.  
  198. I make no warranties, either express or implied, regarding the fitness of the “ARA Scripting Addition” for any particular purpose. Use the “ARA Scripting Addition” at your own risk. The author claims no liability for data loss or any other problems caused directly or indirectly by the “ARA Scripting Addition”.
  199.  
  200.  
  201.